UpdateWorkflow
The UpdateWorkflow web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to change a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Workflow Event, appending note lines and/or modifying the status of the Workflow Event.
UpdateWorkflow Request
The UpdateWorkflow tag instructs the Workflow Service to update the Workflow Event. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
UpdateData |
Container |
This tag instructs the Workflow Service to update a Workflow Event. Contains:
See UpdateWorkflow request container. |
Mandatory |
UpdateData Request Container
The UpdateData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
UpdateWorkflowData |
Container |
See UpdateWorkflowData Request Container for details. |
Mandatory |
UpdateWorkflowData Request Container
The UpdateWorkflowData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
WorkflowNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
EventStatus |
String |
Choice of:
|
Optional |
|
ProcessCommand |
String |
Choice of:
|
Mandatory |
|
ProcessDate |
Date |
The date on which the Workflow Event is processed. YYYY-MM-DD |
Optional |
| ProcessDateTime | Date Time |
The date and time on which the Workflow Event is processed. YYYY-MM-DDThh:mm:ss If a value is supllied, this overrides the value for ProcessDate. |
Optional |
|
ProcessBackDate |
Date |
YYYY-MM-DDZ |
Optional |
|
ContactInformation |
String |
This contains details of the person within the customer's organisation who manages the account. |
Optional |
|
TelephoneNumber |
String15 |
The contact's telephone number. |
Optional |
|
ResolutionRequiredByDate |
String |
A description of how the Workflow Event is to be resolved. |
Optional |
| ResolutionRequiredByDateTime | Date Time |
The date and time by which the Workflow Event must be resolved or the date and time when the Workflow Event must be processed. YYYY-MM-DDThh:mm:ss If no value is supplied, this defaults to midnight. If a value is supplied, it overrides the value for ResolutionRequiredByDate |
Optional |
|
ReasonCode |
String4 |
The reason the Workflow Event was raised. For example, customer request. |
Optional |
|
PassToUserId |
String |
Unique User ID for the Network Operator, Department or Customer Services Representative to whom the Workflow Event has been or is to be sent. |
Optional |
|
IncludeNotesDefault |
Boolean |
Set to 'true' if the Notes are included on the Workflow Event by default. |
Optional |
|
Notes |
String |
Any specific Workflow Event Notes to be updated on the Workflow Event. |
Optional |
|
BillImmediately |
Boolean |
Only has an effect if processing the Workflow Event and it has Sales Ledger Adjustment Lines. Otherwise, this is ignored. |
Optional |
|
InvoiceConsolidationAgreement |
Integer8 |
Only has an effect if processing the Workflow Event and it has Sales Ledger Adjustment Lines. Otherwise, this is ignored. |
Optional |
UpdateWorkflow Response
The UpdateWorkflow response is the response to the UpdateWorkflow request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |